home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / cpp_libs / tools / classdoc.lha / classdoc / abstract.txt next >
Text File  |  1993-08-08  |  1KB  |  36 lines
  1. Classdoc -- Automatic Documentation of C++ Classes
  2.  
  3. Abstract.
  4.  
  5. Classdoc is an AWK program that transforms C++ source code into UNIX
  6. `man'-style documents.  The purpose is to improve the readability of
  7. C++ class documentation without the need for additional document
  8. files.  Classdoc achieves this by formatting and simple reordering of
  9. the source code.  The as yet non-existent paper describes the
  10. capabilities and limitations of classdoc, underlying assumptions of
  11. C++ programming style, and the usefulness of simple-minded parsing
  12. relying on programmer cooperation.sy
  13.  
  14. Although Classdoc may be confused by some programming styles, and will
  15. not understand many perfectly legal C++ header files, it should not
  16. discard any useful information.
  17.  
  18. The distribution contains the following:
  19.  
  20.     1.  An AWK program (requires `nawk', GNU `gawk' or compatible).
  21.  
  22.     2.  A sample shell script + manual page.
  23.  
  24.     3.  This message.
  25.  
  26.     4.  Two test files (list.H and diagram.H) to demonstrate
  27.         a programming style `classdoc' understands.
  28.  
  29. Comments are gratefully accepted.  Please send your views to:
  30.  
  31. Dag Michael Bruck
  32. Department of Automatic Control        Internet:  dag@control.lth.se
  33. Lund Institute of Technology
  34. P. O. Box 118                Phone:    +46 46-108779
  35. S-221 00 Lund, SWEDEN            Fax:    +46 46-138118
  36.